Simplify one-line docstrings for snippets #293
Conversation
Thank you!Thank you for your pull request 😃 🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}. If you have files that automatically render output (e.g. R Markdown), then you should check for the following:
Rendered Changes🔍 Inspect the changes: https://github.com/datacarpentry/image-processing/compare/md-outputs..md-outputs-PR-293 The following changes were observed in the rendered markdown documents: What does this mean?If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible. This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation. ⏱️ Updated at 2023-08-16 02:50:49 +0000 |
There was a problem hiding this comment.
Looks good to me. Thanks, @deppen8. I have suggested only one change, to fix a typo that went undetected until now.
Co-authored-by: Toby Hodges <[email protected]>
Ha! How did I miss that while editing that exact line? Done. |
Auto-generated via {sandpaper}
Source : 0852382
Branch : main
Author : Jacob Deppen <[email protected]>
Time : 2023-08-16 02:52:31 +0000
Message : Merge pull request #293 from deppen8/291-snippet-docstring-formatting
Simplify one-line docstrings for snippets
Auto-generated via {sandpaper}
Source : dd9cf28
Branch : md-outputs
Author : GitHub Actions <[email protected]>
Time : 2023-08-16 02:54:04 +0000
Message : markdown source builds
Auto-generated via {sandpaper}
Source : 0852382
Branch : main
Author : Jacob Deppen <[email protected]>
Time : 2023-08-16 02:52:31 +0000
Message : Merge pull request #293 from deppen8/291-snippet-docstring-formatting
Simplify one-line docstrings for snippets
Closes #291
This PR removes the
*from the triple-quoted docstrings in some of the code snippets. This should hopefully make them look more like the Python standards set it PEP 257 that learners are likely encounter outside the lesson.The PR also removes some extra blank lines that my Markdown linter didn't like.